home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 1.iso / ARGONET / PD / COMMS / IRCMACRO.ZIP / !IRCMacro / !Help next >
Text File  |  1996-08-04  |  7KB  |  143 lines
  1. Name     : !IRCMacro
  2. Purpose  : A macro insertion tool to make IRC easier
  3. Author   : Richard Goodwin
  4. Status   : Freeware
  5. Version  : 2.00 (April 1996)
  6. Features : User definable macros for common IRC commands
  7. Idea     : This particular incarnation thanks to Chris Hawkins
  8.  
  9. This application, along with all files contained within, © Richard Goodwin
  10. 1996.  This application may be freely distributed by any means AS LONG AS:
  11.  
  12. * all files remain intact, with the possible except of the macro definition 
  13.   and option files (see below)
  14. * wherever possible the default definition and option files are distributed,
  15.   rather than customised ones (aimed more at PD libraries etc. than users)
  16.   The macro file is: ..Scripts.Script; the options file is ..Resources.Options
  17. * no unreasonable charge is made.
  18.  
  19. Preamble:
  20. ~~~~~~~~~
  21. IRC is a nice way of getting to meet people.  There you are, uploading a huge
  22. Web site, twiddling your thumbs, when along comes someone from the other side
  23. of the world to make the passing time seem more fleeting.
  24.  
  25. Yeah, right.
  26.  
  27. Anyway, IRCMacro is designed to help you by cutting down on the repition of
  28. typing in commonly-used phrases and commands by inserting them at the touch of
  29. a button.  It also has the added side affect of making you quicker on the
  30. draw...
  31.  
  32. IRCMacro is a quick bodge on HTMacroL and HTML², which were macro insertions
  33. tools for designing web pages.  I tried using normal macro insertion tools, but
  34. they just didn't quite work how I wanted - too slow, couldn't see enough
  35. buttons, forever having to define or load definitions etc.  So, I wrote one
  36. myself!  And out of that IRCMacro was born - because all of the work was
  37. already done, these instructions are actually taking me more time than the
  38. coding.  I guess you could use it for inserting all sorts of things - I have
  39. macros set up in HTML² for signing off my emails the same way, common email
  40. addresses etc.  These macros can go just about anywhere - text editors and word
  41. processors, writable icons, telnet sessions... 
  42.  
  43. Starting Up:
  44. ~~~~~~~~~~~~
  45. Pretty simple really.  Double-click on the !IRCMacro icon to load it, and an
  46. strangely familiar icon will appear on the icon bar.  Clicking with the LEFT
  47. mouse button opens the window which will allow you to select a macro to "type";
  48. clicking with the RIGHT mouse button will load the macro definitions into your
  49. text editor.  Of course the MIDDLE mouse button will open a menu.
  50.  
  51. The Menu:
  52. ~~~~~~~~~
  53.  ___________
  54. |_IRC_Macro_|
  55. | Info     >|  - pretty obvious really
  56. |-----------|
  57. | Macros   >|  - opens macro window, whether you click on it or follow the ">"
  58. |-----------|
  59. | Reload    |  - if you alter the script file, click this to use it instantly
  60. | Save      |  - click on this to save the current definitions as default
  61. |-----------|
  62. |_Quit______|  - Quits the program (surprise!).
  63.  
  64.  
  65. Editing Macros:
  66. ~~~~~~~~~~~~~~~
  67. Looking at the "Script" file you can see that everything is pretty self
  68. explanitary; altering the text after "IRCDefXX=" will define the macro for
  69. whatever XX is (one to twelve); it can be any length up to 255 characters, with
  70. any characters apart from a carriage return (which the program takes to be the
  71. end of the definition) and a backslash - "\".  The backslash is used to tell
  72. the program to insert a carriage return when typing the macro.  "IRCTagXX="
  73. defines what text will appear in the IRCMacro window at position XX - this
  74. should be no more than about 25 characters.
  75.  
  76. Here's an example:
  77. IRCDef02=/away\
  78. IRCTag02=away
  79.  
  80. The "IRCDef02=" part means define macro 2; in this case it is being defined to
  81. type "/away" and then simulate the pressing of the RETURN key (that's what that
  82. "\" on the end is for).  The "IRCTag02=" means that you are defining what
  83. appears in the IRC Macro window for this entry (just the word "away")
  84.  
  85. If the "Script" file is accidentally deleted, there's no need to worry.
  86. Firstly, !IRCMacro won't crash if it doesn't find the file - it just defines
  87. its own macros and uses them.  Secondly, if you do lose a definition file you
  88. can click on "Save" to generate a new one.  Or if you've just lost a file, look
  89. in "!IRCMacro.Backups" - there might be a backup file (it does this when you
  90. click on "Save" just in case...).
  91.  
  92. A lot of work has gone into making sure you don't crash the program with bad
  93. definitions: definitions /don't/ have to be in the same order, the names
  94. /don't/ have to be in capital or lower case letters, and /don't/ have to be all
  95. there - !IRCMacro checks the file for any macro or tag definitions, and if it
  96. finds any it converts the variable part at the front to capitals automatically
  97. then matches them up with the correct program variables.  All you have to do is
  98. make sure there's an "=" right after the definition with gaps, 'cos if there
  99. isn't it will be ignored.  Finally the numbers in the definitions (i.e. the
  100. "02" in "IRCTag02") don't have to have that leading zero, it's just there so
  101. that everything lines up nicely.
  102.  
  103. You can also have more than one file of macros - if you drop a text file
  104. onto the iconbar icon or the macro window it will be parsed to see if any
  105. macros can be found, so you can have a whole set sitting on your hard drive...
  106. Note that these are cumulative, i.e. loading a new definitions file only
  107. overwrites the icons which are defined and leaves all the other macros alone,
  108. so if you just create a file with IRC01 defined and drop this onto the icon,
  109. IRC02-IRC12 will be unaffected.  If you drop a set of macros onto the icon and
  110. think, "Hmm, wouldn't it be nice to have those as the default ones," then just
  111. click on the "Save" menu option and the program will make it so.
  112.  
  113. Have fun!
  114.  
  115. Rich, August '96
  116. email rich.goodwin@argonet.co.uk
  117.  
  118. Oh yes, almost forgot - if you leave the window open when you quit the program,
  119. it'll re-open in the bottom right of the screen when you next load it.  This is
  120. switched on by default.
  121.  
  122. Versions:
  123. ~~~~~~~~~
  124. 1.00: Chopped !HTML² up into !IRCMacro in about half an hour.
  125.  
  126. HTML version:
  127. 2.00: Seperated into 4 windows (and so 4 icons - easier than I hoped!); finally
  128.       got it to do a colour palette; figured out changing writing on buttons
  129.       and saving window states.  Reload function added, as well as the loading
  130.       definitions into a text editor.  Dropping files on icon/windows to do 
  131.       file-specific macros (or load as definitions) added.
  132. 1.04: Added </P> button and changed default centring commands to be compatible 
  133.       with Netscapisms/HTML3.  Distributed via ArgoNet WebPack package.
  134. 1.03: Clicking on a button while a macro was part-way through insertion stopped
  135.       the first macro and the second took over.  Now they'll form an orderly
  136.       queue, space permitting (otherwise you'll get a beep).  Speed increased
  137.       by only polling every fifth character (or on a linespace or space).
  138. 1.02: added polling after each character insert so that characters didn't get 
  139.       lost and line feeds didn't screw up the text underneath.  Slows it down a 
  140.       little, but not too much.  Tested in StrongEd, Edit and Zap.
  141. 1.01: when I actually got round to using it in a real situation, realised I'd 
  142.       forgotten to include <center> and </center>.  Oh well...
  143. 1.00: first version